cs-security-experience-api-services icon

cs-security-experience-api-services

(0 reviews)

📘 Documentación de la API - Servicio de Seguridad de Experiencia

Esta sección describe los atributos y uso del Servicio de Integración de Pagos PayU.

💂️ Información Base

  • Título de la API: Servicio de Integración de Pagos PayU
  • Versión: 1.0.0-SNAPSHOT
  • URL Base: https://cs-payu-sapi-{env}.us-e1.cloudhub.io/api/

Reemplaza {env} con:

  • qa (Aseguramiento de Calidad)

  • prod (Producción)


🔑 Autenticación

Encabezados Requeridos

EncabezadoTipoDescripción
AuthorizationStringToken Bearer en el formato Bearer {{API_KEY}}
client_idStringIdentificador único para clientes de API
X-Correlation-IDStringIdentificador de correlación (opcional)
  • Authorization
    • Longitud: 36 - 200 caracteres
    • Ejemplo: Bearer abcdefghijklmnopqrstuvwxyz1234567890
  • client_id
    • Longitud: 32 - 36 caracteres
    • Ejemplo: 123e4567-e89b-12d3-a456-426614174000
  • X-Correlation-ID
    • Longitud: 36 caracteres (UUID)
    • Ejemplo: 550e8400-e29b-41d4-a716-446655440000

📌 Los encabezados Authorization y client_id son requeridos en todas las solicitudes.


💳 Endpoint: Pago con Tarjeta de Crédito

POST /payments/credit-card

  • Descripción: Procesa un pago con tarjeta de crédito o débito en tiempo real.

Campos Principales

  • transaction.order: Información de la orden (accountId, referenceCode, description, buyer, TX_VALUE)
  • transaction.creditCard: Datos de tarjeta (number, securityCode, expirationDate, name)
  • transaction.payer: Información del pagador
  • transaction.type: AUTHORIZATION_AND_CAPTURE
  • transaction.paymentMethod: VISA, MASTERCARD, etc.

🏦 Endpoint: Pago PSE

POST /payments/PSE

  • Descripción: Procesa un pago mediante PSE (Pagos Seguros en Línea) con bancos colombianos.

Campos Principales

  • transaction.order: Información de la orden
  • transaction.payer: Datos del pagador
  • transaction.extraParameters: FINANCIAL_INSTITUTION_CODE, USER_TYPE (N/J), PSE_REFERENCE1-3
  • transaction.paymentMethod: PSE

💰 Endpoint: Pago en Efectivo

POST /payments/cash-or-referenced

  • Descripción: Genera referencia de pago en efectivo para puntos físicos.

Campos Principales

  • transaction.order: Información de la orden
  • transaction.paymentMethod: BALOTO, EFECTY
  • transaction.type: AUTHORIZATION_AND_CAPTURE

🔐 Endpoint: Crear Token de Tarjeta

POST /credit-card/tokens

  • Descripción: Crea y almacena un token de tarjeta para pagos recurrentes.

Campos Principales

  • payerId: ID del pagador (requerido)
  • name: Nombre del tarjetahabiente (requerido)
  • identificationNumber: Número de identificación (requerido)
  • paymentMethod: VISA, MASTERCARD (requerido)
  • number: Número de tarjeta (requerido)
  • expirationDate: Formato YYYY/MM (requerido)

🔍 Endpoint: Consultar Tokens

GET /credit-card/tokens

  • Parámetros: payerId, identificationNumber
  • Respuesta: Lista de tokens con información enmascarada

🗑️ Endpoint: Eliminar Token

DELETE /credit-card/tokens/{tokenId}

  • Parámetro: tokenId (UUID del token)
  • Respuesta: Confirmación de eliminación

💸 Endpoint: Reembolsos

POST /refunds

  • Descripción: Reembolso total de una transacción.

POST /partial-refunds

  • Descripción: Reembolso parcial de una transacción.

Campos Principales

  • transaction.order.id: ID de orden original
  • transaction.type: REFUND
  • transaction.reason: Motivo del reembolso
  • transaction.parentTransactionId: ID de transacción original
  • transaction.additionalValues.TX_VALUE: Monto a reembolsar (solo parcial)

🏦 Endpoint: Consultar Bancos PSE

GET /PSE/banks

  • Descripción: Listado de bancos disponibles para PSE.
  • Respuesta: Array con pseCode y description

📊 Endpoint: Reportes

GET /reports

  • Parámetros: startDate, endDate, reportType
  • Respuesta: Reporte de transacciones en el período

📋 Endpoint: Métodos de Pago

GET /payments/available-methods

  • Parámetro: accountId
  • Respuesta: Lista de métodos de pago disponibles

📦 Endpoints de Procesamiento Masivo

EndpointMétodoFormatosDescripción
/credit-card/tokens/bulk/registrationPOSTJSON, CSV, BinaryRegistro masivo de tokens
/credit-card/tokens/bulkDELETEJSON, CSV, BinaryEliminación masiva de tokens
/payments/bulk-tokensPOSTJSON, CSV, BinaryPagos masivos con tokens

Formato CSV: tokenId,referenceCode,description,amount,currency,buyerEmail


📊 Parámetros Comunes

ParámetroTipoDescripciónRequerido
client_idStringIdentificador del cliente de API
AuthorizationStringToken Bearer para autenticación
X-Correlation-IDStringID de correlación para trazabilidad

🔐 Esquemas de Seguridad

Aplicación de Client ID

CampoTipoRequeridoLongitudRegex
client_idString32 - 36[a-zA-Z0-9-]
client_secretString32 - 64[a-zA-Z0-9]

OAuth 2.0

CampoTipoRequeridoLongitudRegex
AuthorizationString36 - 200[a-zA-Z0-9-_.]

⚠️ Códigos de Error

CódigoDescripciónSolución Sugerida
200ÉxitoTransacción procesada correctamente
400Solicitud IncorrectaRevisar sintaxis de solicitud y parámetros requeridos
401No AutorizadoValidar credenciales de autenticación OAuth
403ProhibidoVerificar permisos del client_id
404No EncontradoConfirmar la URL del endpoint y recursos solicitados
422Entidad No ProcesableTransacción rechazada por la pasarela de pagos
429Demasiadas SolicitudesReducir frecuencia de requests, implementar rate limiting
500Error Interno del ServidorReintentar o contactar soporte técnico
503Servicio No DisponibleServicio en mantenimiento, reintentar más tarde
504Timeout de GatewayConsultar estado de transacción antes de reintentar

🔢 Tipos de Transacción

TipoDescripción
AUTHORIZATIONAutorización de pago sin captura
CAPTURECaptura de pago previamente autorizado
AUTHORIZATION_AND_CAPTUREAutorización y captura en una sola operación
REFUNDReembolso de transacción
VOIDAnulación de transacción

💳 Métodos de Pago Soportados

MétodoCódigoPaísDescripción
VisaVISACOTarjeta de crédito/débito Visa
MastercardMASTERCARDCOTarjeta de crédito/débito MC
American ExpressAMEXCOTarjeta de crédito Amex
Diners ClubDINERSCOTarjeta de crédito Diners
PSEPSECOPagos Seguros en Línea
BalotoBALOTOCOPago en efectivo Baloto
EfectyEFECTYCOPago en efectivo Efecty

📞 Soporte

Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co


📅 Información Adicional

Documentación generada y actualizada en Noviembre 2025 por epalma@fgs.co - Edna Nayibe Palma

© 2025 Fundación Grupo Social - Colmena. API cs-payu-sapi


📋 Nota Importante: Esta documentación se actualiza continuamente. Para la versión más reciente y cambios en tiempo real, consulta siempre el Portal de Exchange oficial.

🔒 Aviso de Seguridad: Nunca compartas credenciales de API en repositorios públicos o documentación. Usa siempre variables de entorno para información sensible y rota tokens regularmente. Cumple con PCI-DSS al manejar datos de tarjetas.

💳 Aviso Legal: El procesamiento de pagos está sujeto a términos y condiciones de la pasarela de pagos PayU. Las transacciones pueden estar sujetas a comisiones según el método de pago y configuración del comercio.


Reviews